跳到主要内容
版本：v1.2-dev

Create a Virtual Machine

POST /apis/kubevirt.io/v1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachines

Create a VirtualMachine object.

Path Parameters
  • namespace string required

    Object name and auth scope, such as for teams and projects

Request Body required
  • apiVersion string required

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

  • kind string required

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  • metadata object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

  • annotations object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

  • property name* string
  • clusterName string

    Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25.

    The name in the go struct is changed to help clients detect accidental use.

  • creationTimestamp date-time

    Default value: [object Object]

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

    Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

  • deletionGracePeriodSeconds int64

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

  • deletionTimestamp date-time

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

    Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

  • finalizers string[]

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

  • generateName string

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

    If this field is specified and the generated name exists, the server will return a 409.

    Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

  • generation int64

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

  • labels object

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

  • property name* string
  • managedFields object[]

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

  • Array [
  • apiVersion string

    APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

  • fieldsType string

    FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

  • fieldsV1 object

    FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

  • manager string

    Manager is an identifier of the workflow managing these fields.

  • operation string

    Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

  • subresource string

    Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

  • time date-time

    Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

  • ]
  • name string required

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

  • namespace string

    Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

    Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

  • ownerReferences object[]

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

  • Array [
  • apiVersion string required

    API version of the referent.

  • blockOwnerDeletion boolean

    If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

  • controller boolean

    If true, this reference points to the managing controller.

  • kind string required

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  • name string required

    Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

  • uid string required

    UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

  • ]
  • resourceVersion string

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

    Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

  • selfLink string

    Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

  • uid string

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

    Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

  • spec object required

    Spec contains the specification of VirtualMachineInstance created

  • dataVolumeTemplates object[]

    dataVolumeTemplates is a list of dataVolumes that the VirtualMachineInstance template can reference. DataVolumes in this list are dynamically created for the VirtualMachine and are tied to the VirtualMachine's life-cycle.

  • Array [
  • apiVersion string required

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

  • kind string required

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  • metadata object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

  • annotations object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

  • property name* string
  • clusterName string

    Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25.

    The name in the go struct is changed to help clients detect accidental use.

  • creationTimestamp date-time

    Default value: [object Object]

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

    Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

  • deletionGracePeriodSeconds int64

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

  • deletionTimestamp date-time

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

    Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

  • finalizers string[]

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

  • generateName string

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

    If this field is specified and the generated name exists, the server will return a 409.

    Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

  • generation int64

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

  • labels object

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

  • property name* string
  • managedFields object[]

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

  • Array [
  • apiVersion string

    APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

  • fieldsType string

    FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

  • fieldsV1 object

    FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

  • manager string

    Manager is an identifier of the workflow managing these fields.

  • operation string

    Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

  • subresource string

    Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

  • time date-time

    Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

  • ]
  • name string required

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

  • namespace string

    Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

    Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

  • ownerReferences object[]

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

  • Array [
  • apiVersion string required

    API version of the referent.

  • blockOwnerDeletion boolean

    If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

  • controller boolean

    If true, this reference points to the managing controller.

  • kind string required

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  • name string required

    Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

  • uid string required

    UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

  • ]
  • resourceVersion string

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

    Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

  • selfLink string

    Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

  • uid string

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

    Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

  • spec object required

    DataVolumeSpec contains the DataVolume specification.

  • checkpoints object[]

    Checkpoints is a list of DataVolumeCheckpoints, representing stages in a multistage import.

  • Array [
  • current string required

    Current is the identifier of the snapshot created for this checkpoint.

  • previous string required

    Previous is the identifier of the snapshot from the previous checkpoint.

  • ]
  • contentType string

    DataVolumeContentType options: "kubevirt", "archive"

  • finalCheckpoint boolean

    FinalCheckpoint indicates whether the current DataVolumeCheckpoint is the final checkpoint.

  • preallocation boolean

    Preallocation controls whether storage for DataVolumes should be allocated in advance.

  • priorityClassName string

    PriorityClassName for Importer, Cloner and Uploader pod

  • pvc object

    PVC is the PVC specification

  • accessModes string[]

    accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

  • dataSource object

    dataSource field can be used to specify either: An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

  • apiGroup string

    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

  • kind string required

    Kind is the type of resource being referenced

  • name string required

    Name is the name of resource being referenced

  • dataSourceRef object

    dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.

    • While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
  • apiGroup string

    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

  • kind string required

    Kind is the type of resource being referenced

  • name string required

    Name is the name of resource being referenced

  • resources object

    resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

  • limits object

    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

  • property name* string
  • requests object

    Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

  • property name* string
  • selector object

    selector is a label query over volumes to consider for binding.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • storageClassName string

    storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

  • volumeMode string

    volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

  • volumeName string

    volumeName is the binding reference to the PersistentVolume backing this claim.

  • source object

    Source is the src of the data for the requested DataVolume

  • blank object

    DataVolumeBlankImage provides the parameters to create a new raw blank image for the PVC

  • http object

    DataVolumeSourceHTTP can be either an http or https endpoint, with an optional basic auth user name and password, and an optional configmap containing additional CAs

  • certConfigMap string

    CertConfigMap is a configmap reference, containing a Certificate Authority(CA) public key, and a base64 encoded pem certificate

  • extraHeaders string[]

    ExtraHeaders is a list of strings containing extra headers to include with HTTP transfer requests

  • secretExtraHeaders string[]

    SecretExtraHeaders is a list of Secret references, each containing an extra HTTP header that may include sensitive information

  • secretRef string

    SecretRef A Secret reference, the secret should contain accessKeyId (user name) base64 encoded, and secretKey (password) also base64 encoded

  • url string required

    URL is the URL of the http(s) endpoint

  • imageio object

    DataVolumeSourceImageIO provides the parameters to create a Data Volume from an imageio source

  • certConfigMap string

    CertConfigMap provides a reference to the CA cert

  • diskId string required

    DiskID provides id of a disk to be imported

  • secretRef string

    SecretRef provides the secret reference needed to access the ovirt-engine

  • url string required

    URL is the URL of the ovirt-engine

  • pvc object

    DataVolumeSourcePVC provides the parameters to create a Data Volume from an existing PVC

  • name string required

    The name of the source PVC

  • namespace string required

    The namespace of the source PVC

  • registry object

    DataVolumeSourceRegistry provides the parameters to create a Data Volume from an registry source

  • certConfigMap string

    CertConfigMap provides a reference to the Registry certs

  • imageStream string

    ImageStream is the name of image stream for import

  • pullMethod string

    PullMethod can be either "pod" (default import), or "node" (node docker cache based import)

  • secretRef string

    SecretRef provides the secret reference needed to access the Registry source

  • url string

    URL is the url of the registry source (starting with the scheme: docker, oci-archive)

  • s3 object

    DataVolumeSourceS3 provides the parameters to create a Data Volume from an S3 source

  • certConfigMap string

    CertConfigMap is a configmap reference, containing a Certificate Authority(CA) public key, and a base64 encoded pem certificate

  • secretRef string

    SecretRef provides the secret reference needed to access the S3 source

  • url string required

    URL is the url of the S3 source

  • upload object

    DataVolumeSourceUpload provides the parameters to create a Data Volume by uploading the source

  • vddk object

    DataVolumeSourceVDDK provides the parameters to create a Data Volume from a Vmware source

  • backingFile string

    BackingFile is the path to the virtual hard disk to migrate from vCenter/ESXi

  • initImageURL string

    InitImageURL is an optional URL to an image containing an extracted VDDK library, overrides v2v-vmware config map

  • secretRef string

    SecretRef provides a reference to a secret containing the username and password needed to access the vCenter or ESXi host

  • thumbprint string

    Thumbprint is the certificate thumbprint of the vCenter or ESXi host

  • url string

    URL is the URL of the vCenter or ESXi host with the VM to migrate

  • uuid string

    UUID is the UUID of the virtual machine that the backing file is attached to in vCenter/ESXi

  • sourceRef object

    SourceRef is an indirect reference to the source of data for the requested DataVolume

  • kind string required

    The kind of the source reference, currently only "DataSource" is supported

  • name string required

    The name of the source reference

  • namespace string

    The namespace of the source reference, defaults to the DataVolume namespace

  • storage object

    Storage is the requested storage specification

  • accessModes string[]

    AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

  • dataSource object

    This field can be used to specify either: An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source.

  • apiGroup string

    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

  • kind string required

    Kind is the type of resource being referenced

  • name string required

    Name is the name of resource being referenced

  • resources object

    Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

  • limits object

    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

  • property name* string
  • requests object

    Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

  • property name* string
  • selector object

    A label query over volumes to consider for binding.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • storageClassName string

    Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

  • volumeMode string

    volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

  • volumeName string

    VolumeName is the binding reference to the PersistentVolume backing this claim.

  • status object

    DataVolumeTemplateDummyStatus is here simply for backwards compatibility with a previous API.

  • ]
  • flavor object

    FlavorMatcher references a flavor that is used to fill fields in Template

  • kind string

    Kind specifies which flavor resource is referenced. Allowed values are: "VirtualMachineFlavor" and "VirtualMachineClusterFlavor". If not specified, "VirtualMachineClusterFlavor" is used by default.

  • name string required

    Name is the name of the VirtualMachineFlavor or VirtualMachineClusterFlavor

  • preference object

    PreferenceMatcher references a set of preference that is used to fill fields in Template

  • kind string

    Kind specifies which preference resource is referenced. Allowed values are: "VirtualMachinePreference" and "VirtualMachineClusterPreference". If not specified, "VirtualMachineClusterPreference" is used by default.

  • name string required

    Name is the name of the VirtualMachinePreference or VirtualMachineClusterPreference

  • runStrategy string

    Running state indicates the requested running state of the VirtualMachineInstance mutually exclusive with Running

  • running boolean

    Running controls whether the associatied VirtualMachineInstance is created or not Mutually exclusive with RunStrategy

  • template object required

    Template is the direct specification of VirtualMachineInstance

  • metadata object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

  • annotations object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

  • property name* string
  • clusterName string

    Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25.

    The name in the go struct is changed to help clients detect accidental use.

  • creationTimestamp date-time

    Default value: [object Object]

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

    Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

  • deletionGracePeriodSeconds int64

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

  • deletionTimestamp date-time

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

    Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

  • finalizers string[]

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

  • generateName string

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

    If this field is specified and the generated name exists, the server will return a 409.

    Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

  • generation int64

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

  • labels object

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

  • property name* string
  • managedFields object[]

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

  • Array [
  • apiVersion string

    APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

  • fieldsType string

    FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

  • fieldsV1 object

    FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

  • manager string

    Manager is an identifier of the workflow managing these fields.

  • operation string

    Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

  • subresource string

    Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

  • time date-time

    Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

  • ]
  • name string required

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

  • namespace string

    Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

    Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

  • ownerReferences object[]

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

  • Array [
  • apiVersion string required

    API version of the referent.

  • blockOwnerDeletion boolean

    If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

  • controller boolean

    If true, this reference points to the managing controller.

  • kind string required

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  • name string required

    Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

  • uid string required

    UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

  • ]
  • resourceVersion string

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

    Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

  • selfLink string

    Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

  • uid string

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

    Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

  • spec object

    VirtualMachineInstance Spec contains the VirtualMachineInstance specification.

  • accessCredentials object[]

    Specifies a set of public keys to inject into the vm guest

  • Array [
  • sshPublicKey object

    SSHPublicKey represents the source and method of applying a ssh public key into a guest virtual machine.

  • propagationMethod object required

    PropagationMethod represents how the public key is injected into the vm guest.

  • configDrive object

    ConfigDrivePropagation means that the ssh public keys are injected into the VM using metadata using the configDrive cloud-init provider

  • qemuGuestAgent object

    QemuGuestAgentAccessCredentailPropagation means ssh public keys are dynamically injected into the vm at runtime via the qemu guest agent. This feature requires the qemu guest agent to be running within the guest.

  • users string[] required

    Users represents a list of guest users that should have the ssh public keys added to their authorized_keys file.

  • source object required

    Source represents where the public keys are pulled from

  • secret object

    Secret means that the access credential is pulled from a kubernetes secret

  • secretName string required

    SecretName represents the name of the secret in the VMI's namespace

  • userPassword object

    UserPassword represents the source and method for applying a guest user's password

  • propagationMethod object required

    propagationMethod represents how the user passwords are injected into the vm guest.

  • qemuGuestAgent object

    QemuGuestAgentAccessCredentailPropagation means passwords are dynamically injected into the vm at runtime via the qemu guest agent. This feature requires the qemu guest agent to be running within the guest.

  • source object required

    Source represents where the user passwords are pulled from

  • secret object

    Secret means that the access credential is pulled from a kubernetes secret

  • secretName string required

    SecretName represents the name of the secret in the VMI's namespace

  • ]
  • affinity object

    If affinity is specifies, obey all the affinity rules

  • nodeAffinity object

    Describes node affinity scheduling rules for the pod.

  • preferredDuringSchedulingIgnoredDuringExecution object[]

    The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.

  • Array [
  • preference object required

    A node selector term, associated with the corresponding weight.

  • matchExpressions object[]

    A list of node selector requirements by node's labels.

  • Array [
  • key string required

    The label key that the selector applies to.

  • operator string required

    Possible values: [DoesNotExist, Exists, Gt, In, Lt, NotIn]

    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

    Possible enum values:

    • "DoesNotExist"
    • "Exists"
    • "Gt"
    • "In"
    • "Lt"
    • "NotIn"
  • values string[]

    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

  • ]
  • matchFields object[]

    A list of node selector requirements by node's fields.

  • Array [
  • key string required

    The label key that the selector applies to.

  • operator string required

    Possible values: [DoesNotExist, Exists, Gt, In, Lt, NotIn]

    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

    Possible enum values:

    • "DoesNotExist"
    • "Exists"
    • "Gt"
    • "In"
    • "Lt"
    • "NotIn"
  • values string[]

    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

  • ]
  • weight int32 required

    Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

  • ]
  • requiredDuringSchedulingIgnoredDuringExecution object

    If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

  • nodeSelectorTerms object[] required

    Required. A list of node selector terms. The terms are ORed.

  • Array [
  • matchExpressions object[]

    A list of node selector requirements by node's labels.

  • Array [
  • key string required

    The label key that the selector applies to.

  • operator string required

    Possible values: [DoesNotExist, Exists, Gt, In, Lt, NotIn]

    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

    Possible enum values:

    • "DoesNotExist"
    • "Exists"
    • "Gt"
    • "In"
    • "Lt"
    • "NotIn"
  • values string[]

    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

  • ]
  • matchFields object[]

    A list of node selector requirements by node's fields.

  • Array [
  • key string required

    The label key that the selector applies to.

  • operator string required

    Possible values: [DoesNotExist, Exists, Gt, In, Lt, NotIn]

    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

    Possible enum values:

    • "DoesNotExist"
    • "Exists"
    • "Gt"
    • "In"
    • "Lt"
    • "NotIn"
  • values string[]

    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

  • ]
  • ]
  • podAffinity object

    Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

  • preferredDuringSchedulingIgnoredDuringExecution object[]

    The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

  • Array [
  • podAffinityTerm object required

    Required. A pod affinity term, associated with the corresponding weight.

  • labelSelector object

    A label query over a set of resources, in this case pods.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • namespaceSelector object

    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • namespaces string[]

    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

  • topologyKey string required

    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

  • weight int32 required

    weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

  • ]
  • requiredDuringSchedulingIgnoredDuringExecution object[]

    If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

  • Array [
  • labelSelector object

    A label query over a set of resources, in this case pods.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • namespaceSelector object

    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • namespaces string[]

    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

  • topologyKey string required

    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

  • ]
  • podAntiAffinity object

    Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

  • preferredDuringSchedulingIgnoredDuringExecution object[]

    The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

  • Array [
  • podAffinityTerm object required

    Required. A pod affinity term, associated with the corresponding weight.

  • labelSelector object

    A label query over a set of resources, in this case pods.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • namespaceSelector object

    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • namespaces string[]

    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

  • topologyKey string required

    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

  • weight int32 required

    weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

  • ]
  • requiredDuringSchedulingIgnoredDuringExecution object[]

    If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

  • Array [
  • labelSelector object

    A label query over a set of resources, in this case pods.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • namespaceSelector object

    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • namespaces string[]

    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

  • topologyKey string required

    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

  • ]
  • dnsConfig object

    Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

  • nameservers string[]

    A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.

  • options object[]

    A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.

  • Array [
  • name string

    Required.

  • value string
  • ]
  • searches string[]

    A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.

  • dnsPolicy string

    Possible values: [ClusterFirst, ClusterFirstWithHostNet, Default, None]

    Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

    Possible enum values:

    • "ClusterFirst" indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
    • "ClusterFirstWithHostNet" indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
    • "Default" indicates that the pod should use the default (as determined by kubelet) DNS settings.
    • "None" indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
  • domain object required

    Specification of the desired behavior of the VirtualMachineInstance on the host.

  • chassis object

    Chassis specifies the chassis info passed to the domain.

  • asset string
  • manufacturer string
  • serial string
  • sku string
  • version string
  • clock object

    Clock sets the clock and timers of the vmi.

  • timer object

    Timer specifies whih timers are attached to the vmi.

  • hpet object

    HPET (High Precision Event Timer) - multiple timers with periodic interrupts.

  • present boolean

    Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

  • tickPolicy string

    TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup", "merge", "discard".

  • hyperv object

    Hyperv (Hypervclock) - lets guests read the host’s wall clock time (paravirtualized). For windows guests.

  • present boolean

    Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

  • kvm object

    KVM (KVM clock) - lets guests read the host’s wall clock time (paravirtualized). For linux guests.

  • present boolean

    Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

  • pit object

    PIT (Programmable Interval Timer) - a timer with periodic interrupts.

  • present boolean

    Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

  • tickPolicy string

    TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup", "discard".

  • rtc object

    RTC (Real Time Clock) - a continuously running timer with periodic interrupts.

  • present boolean

    Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

  • tickPolicy string

    TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup".

  • track string

    Track the guest or the wall clock.

  • timezone string

    Timezone sets the guest clock to the specified timezone. Zone name follows the TZ environment variable format (e.g. 'America/New_York').

  • utc object

    UTC sets the guest clock to UTC on each boot. If an offset is specified, guest changes to the clock will be kept during reboots and are not reset.

  • offsetSeconds int32

    OffsetSeconds specifies an offset in seconds, relative to UTC. If set, guest changes to the clock will be kept during reboots and not reset.

  • cpu object

    CPU allow specified the detailed CPU topology inside the vmi.

  • cores int64

    Cores specifies the number of cores inside the vmi. Must be a value greater or equal 1.

  • dedicatedCpuPlacement boolean

    DedicatedCPUPlacement requests the scheduler to place the VirtualMachineInstance on a node with enough dedicated pCPUs and pin the vCPUs to it.

  • features object[]

    Features specifies the CPU features list inside the VMI.

  • Array [
  • name string required

    Name of the CPU feature

  • policy string

    Policy is the CPU feature attribute which can have the following attributes: force - The virtual CPU will claim the feature is supported regardless of it being supported by host CPU. require - Guest creation will fail unless the feature is supported by the host CPU or the hypervisor is able to emulate it. optional - The feature will be supported by virtual CPU if and only if it is supported by host CPU. disable - The feature will not be supported by virtual CPU. forbid - Guest creation will fail if the feature is supported by host CPU. Defaults to require

  • ]
  • isolateEmulatorThread boolean

    IsolateEmulatorThread requests one more dedicated pCPU to be allocated for the VMI to place the emulator thread on it.

  • model string

    Model specifies the CPU model inside the VMI. List of available models https://github.com/libvirt/libvirt/tree/master/src/cpu_map. It is possible to specify special cases like "host-passthrough" to get the same CPU as the node and "host-model" to get CPU closest to the node one. Defaults to host-model.

  • numa object

    NUMA allows specifying settings for the guest NUMA topology

  • guestMappingPassthrough object

    GuestMappingPassthrough will create an efficient guest topology based on host CPUs exclusively assigned to a pod. The created topology ensures that memory and CPUs on the virtual numa nodes never cross boundaries of host numa nodes.

  • realtime object

    Realtime instructs the virt-launcher to tune the VMI for lower latency, optional for real time workloads

  • mask string

    Mask defines the vcpu mask expression that defines which vcpus are used for realtime. Format matches libvirt's expressions. Example: "0-3,^1","0,2,3","2-3"

  • sockets int64

    Sockets specifies the number of sockets inside the vmi. Must be a value greater or equal 1.

  • threads int64

    Threads specifies the number of threads inside the vmi. Must be a value greater or equal 1.

  • devices object required

    Devices allows adding disks, network interfaces, and others

  • autoattachGraphicsDevice boolean

    Whether to attach the default graphics device or not. VNC will not be available if set to false. Defaults to true.

  • autoattachMemBalloon boolean

    Whether to attach the Memory balloon device with default period. Period can be adjusted in virt-config. Defaults to true.

  • autoattachPodInterface boolean

    Whether to attach a pod network interface. Defaults to true.

  • autoattachSerialConsole boolean

    Whether to attach the default serial console or not. Serial console access will not be available if set to false. Defaults to true.

  • blockMultiQueue boolean

    Whether or not to enable virtio multi-queue for block devices. Defaults to false.

  • clientPassthrough object

    To configure and access client devices such as redirecting USB

  • disableHotplug boolean

    DisableHotplug disabled the ability to hotplug disks.

  • disks object[]

    Disks describes disks, cdroms and luns which are connected to the vmi.

  • Array [
  • blockSize object

    If specified, the virtual disk will be presented with the given block sizes.

  • custom object

    CustomBlockSize represents the desired logical and physical block size for a VM disk.

  • logical int32 required
  • physical int32 required
  • matchVolume object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • bootOrder int32

    BootOrder is an integer value > 0, used to determine ordering of boot devices. Lower values take precedence. Each disk or interface that has a boot order must have a unique value. Disks without a boot order are not tried if a disk with a boot order exists.

  • cache string

    Cache specifies which kvm disk cache mode should be used. Supported values are: CacheNone, CacheWriteThrough.

  • cdrom object

    Attach a volume as a cdrom to the vmi.

  • bus string

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

  • readonly boolean

    ReadOnly. Defaults to true.

  • tray string

    Tray indicates if the tray of the device is open or closed. Allowed values are "open" and "closed". Defaults to closed.

  • dedicatedIOThread boolean

    dedicatedIOThread indicates this disk should have an exclusive IO Thread. Enabling this implies useIOThreads = true. Defaults to false.

  • disk object

    Attach a volume as a disk to the vmi.

  • bus string

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

  • pciAddress string

    If specified, the virtual disk will be placed on the guests pci address with the specified PCI address. For example: 0000:81:01.10

  • readonly boolean

    ReadOnly. Defaults to false.

  • io string

    IO specifies which QEMU disk IO mode should be used. Supported values are: native, default, threads.

  • lun object

    Attach a volume as a LUN to the vmi.

  • bus string

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

  • readonly boolean

    ReadOnly. Defaults to false.

  • name string required

    Name is the device name

  • serial string

    Serial provides the ability to specify a serial number for the disk device.

  • shareable boolean

    If specified the disk is made sharable and multiple write from different VMs are permitted

  • tag string

    If specified, disk address and its tag will be provided to the guest via config drive metadata

  • ]
  • filesystems object[]

    Filesystems describes filesystem which is connected to the vmi.

  • Array [
  • name string required

    Name is the device name

  • virtiofs object required

    Virtiofs is supported

  • ]
  • gpus object[]

    Whether to attach a GPU device to the vmi.

  • Array [
  • deviceName string required
  • name string required

    Name of the GPU device as exposed by a device plugin

  • tag string

    If specified, the virtual network interface address and its tag will be provided to the guest via config drive

  • virtualGPUOptions object
  • display object
  • enabled boolean

    Enabled determines if a display addapter backed by a vGPU should be enabled or disabled on the guest. Defaults to true.

  • ramFB object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • ]
  • hostDevices object[]

    Whether to attach a host device to the vmi.

  • Array [
  • deviceName string required

    DeviceName is the resource name of the host device exposed by a device plugin

  • name string required
  • tag string

    If specified, the virtual network interface address and its tag will be provided to the guest via config drive

  • ]
  • inputs object[]

    Inputs describe input devices

  • Array [
  • bus string

    Bus indicates the bus of input device to emulate. Supported values: virtio, usb.

  • name string required

    Name is the device name

  • type string required

    Type indicated the type of input device. Supported values: tablet.

  • ]
  • interfaces object[]

    Interfaces describe network interfaces which are added to the vmi.

  • Array [
  • bootOrder int32

    BootOrder is an integer value > 0, used to determine ordering of boot devices. Lower values take precedence. Each interface or disk that has a boot order must have a unique value. Interfaces without a boot order are not tried.

  • bridge object

    InterfaceBridge connects to a given network via a linux bridge.

  • dhcpOptions object

    If specified the network interface will pass additional DHCP options to the VMI

  • bootFileName string

    If specified will pass option 67 to interface's DHCP server

  • ntpServers string[]

    If specified will pass the configured NTP server to the VM via DHCP option 042.

  • privateOptions object[]

    If specified will pass extra DHCP options for private use, range: 224-254

  • Array [
  • option int32 required

    Option is an Integer value from 224-254 Required.

  • value string required

    Value is a String value for the Option provided Required.

  • ]
  • tftpServerName string

    If specified will pass option 66 to interface's DHCP server

  • macAddress string

    Interface MAC address. For example: de:ad:00:00:be:af or DE-AD-00-00-BE-AF.

  • macvtap object

    InterfaceMacvtap connects to a given network by extending the Kubernetes node's L2 networks via a macvtap interface.

  • masquerade object

    InterfaceMasquerade connects to a given network using netfilter rules to nat the traffic.

  • model string

    Interface model. One of: e1000, e1000e, ne2k_pci, pcnet, rtl8139, virtio. Defaults to virtio.

  • name string required

    Logical name of the interface as well as a reference to the associated networks. Must match the Name of a Network.

  • pciAddress string

    If specified, the virtual network interface will be placed on the guests pci address with the specified PCI address. For example: 0000:81:01.10

  • ports object[]

    List of ports to be forwarded to the virtual machine.

  • Array [
  • name string

    If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

  • port int32 required

    Number of port to expose for the virtual machine. This must be a valid port number, 0 < x < 65536.

  • protocol string

    Protocol for port. Must be UDP or TCP. Defaults to "TCP".

  • ]
  • slirp object

    InterfaceSlirp connects to a given network using QEMU user networking mode.

  • sriov object

    InterfaceSRIOV connects to a given network by passing-through an SR-IOV PCI device via vfio.

  • tag string

    If specified, the virtual network interface address and its tag will be provided to the guest via config drive

  • ]
  • networkInterfaceMultiqueue boolean

    If specified, virtual network interfaces configured with a virtio bus will also enable the vhost multiqueue feature for network devices. The number of queues created depends on additional factors of the VirtualMachineInstance, like the number of guest CPUs.

  • rng object

    Whether to have random number generator from host

  • sound object

    Whether to emulate a sound device.

  • model string

    We only support ich9 or ac97. If SoundDevice is not set: No sound card is emulated. If SoundDevice is set but Model is not: ich9

  • name string required

    User's defined name for this sound device

  • tpm object

    Whether to emulate a TPM device.

  • useVirtioTransitional boolean

    Fall back to legacy virtio 0.9 support if virtio bus is selected on devices. This is helpful for old machines like CentOS6 or RHEL6 which do not understand virtio_non_transitional (virtio 1.0).

  • watchdog object

    Watchdog describes a watchdog device which can be added to the vmi.

  • i6300esb object

    i6300esb watchdog device.

  • action string

    The action to take. Valid values are poweroff, reset, shutdown. Defaults to reset.

  • name string required

    Name of the watchdog.

  • features object

    Features like acpi, apic, hyperv, smm.

  • acpi object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • apic object

    Defaults to the machine type setting.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • endOfInterrupt boolean

    EndOfInterrupt enables the end of interrupt notification in the guest. Defaults to false.

  • hyperv object

    Defaults to the machine type setting.

  • evmcs object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • frequencies object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • ipi object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • reenlightenment object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • relaxed object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • reset object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • runtime object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • spinlocks object

    Spinlocks allows to configure the spinlock retry attempts.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • spinlocks int64

    Retries indicates the number of retries. Must be a value greater or equal 4096. Defaults to 4096.

  • synic object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • synictimer object

    SyNICTimer enables Synthetic Interrupt Controller Timers, reducing CPU load. Defaults to the machine type setting.

  • direct object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • enabled boolean
  • tlbflush object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • vapic object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • vendorid object

    VendorID allows setting the hypervisor vendor id. Defaults to the machine type setting.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • vendorid string

    VendorID sets the hypervisor vendor id, visible to the vmi. String up to twelve characters.

  • vpindex object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • kvm object

    Configure how KVM presence is exposed to the guest.

  • hidden boolean

    Hide the KVM hypervisor from standard MSR based discovery. Defaults to false

  • pvspinlock object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • smm object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • firmware object

    Firmware.

  • bootloader object

    Settings to control the bootloader that is used.

  • bios object

    If set (default), BIOS will be used.

  • useSerial boolean

    If set, the BIOS output will be transmitted over serial

  • efi object

    If set, EFI will be used instead of BIOS.

  • secureBoot boolean

    If set, SecureBoot will be enabled and the OVMF roms will be swapped for SecureBoot-enabled ones. Requires SMM to be enabled. Defaults to true

  • kernelBoot object

    Settings to set the kernel for booting.

  • container object

    Container defines the container that containes kernel artifacts

  • image string required

    Image that contains initrd / kernel files.

  • imagePullPolicy string

    Possible values: [Always, IfNotPresent, Never]

    Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

    Possible enum values:

    • "Always" means that kubelet always attempts to pull the latest image. Container will fail If the pull fails.
    • "IfNotPresent" means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails.
    • "Never" means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn't present
  • imagePullSecret string

    ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist.

  • initrdPath string

    the fully-qualified path to the ramdisk image in the host OS

  • kernelPath string

    The fully-qualified path to the kernel image in the host OS

  • kernelArgs string

    Arguments to be passed to the kernel at boot time

  • serial string

    The system-serial-number in SMBIOS

  • uuid string

    UUID reported by the vmi bios. Defaults to a random generated uid.

  • ioThreadsPolicy string

    Controls whether or not disks will share IOThreads. Omitting IOThreadsPolicy disables use of IOThreads. One of: shared, auto

  • launchSecurity object

    Launch Security setting of the vmi.

  • sev object

    AMD Secure Encrypted Virtualization (SEV).

  • machine object

    Machine type.

  • type string

    QEMU machine type is the actual chipset of the VirtualMachineInstance.

  • memory object

    Memory allow specifying the VMI memory features.

  • guest string

    Guest allows to specifying the amount of memory which is visible inside the Guest OS. The Guest must lie between Requests and Limits from the resources section. Defaults to the requested memory in the resources section if not specified.

  • hugepages object

    Hugepages allow to use hugepages for the VirtualMachineInstance instead of regular memory.

  • pageSize string

    PageSize specifies the hugepage size, for x86_64 architecture valid values are 1Gi and 2Mi.

  • resources object

    Resources describes the Compute Resources required by this vmi.

  • limits object

    Limits describes the maximum amount of compute resources allowed. Valid resource keys are "memory" and "cpu".

  • property name* string
  • overcommitGuestOverhead boolean

    Don't ask the scheduler to take the guest-management overhead into account. Instead put the overhead only into the container's memory limit. This can lead to crashes if all memory is in use on a node. Defaults to false.

  • requests object

    Requests is a description of the initial vmi resources. Valid resource keys are "memory" and "cpu".

  • property name* string
  • evictionStrategy string

    EvictionStrategy can be set to "LiveMigrate" if the VirtualMachineInstance should be migrated instead of shut-off in case of a node drain.

  • hostname string

    Specifies the hostname of the vmi If not specified, the hostname will be set to the name of the vmi, if dhcp or cloud-init is configured properly.

  • livenessProbe object

    Periodic probe of VirtualMachineInstance liveness. VirtualmachineInstances will be stopped if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • exec object

    One and only one of the following should be specified. Exec specifies the action to take, it will be executed on the guest through the qemu-guest-agent. If the guest agent is not available, this probe will fail.

  • command string[]

    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

  • failureThreshold int32

    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

  • guestAgentPing object

    GuestAgentPing contacts the qemu-guest-agent for availability checks.

  • httpGet object

    HTTPGet specifies the http request to perform.

  • host string

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

  • httpHeaders object[]

    Custom headers to set in the request. HTTP allows repeated headers.

  • Array [
  • name string required

    The header field name

  • value string required

    The header field value

  • ]
  • path string

    Path to access on the HTTP server.

  • port int-or-string required

    Default value: [object Object]

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

  • scheme string

    Possible values: [HTTP, HTTPS]

    Scheme to use for connecting to the host. Defaults to HTTP.

    Possible enum values:

    • "HTTP" means that the scheme used will be http://
    • "HTTPS" means that the scheme used will be https://
  • initialDelaySeconds int32

    Number of seconds after the VirtualMachineInstance has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • periodSeconds int32

    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

  • successThreshold int32

    Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

  • tcpSocket object

    TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

  • host string

    Optional: Host name to connect to, defaults to the pod IP.

  • port int-or-string required

    Default value: [object Object]

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

  • timeoutSeconds int32

    Number of seconds after which the probe times out. For exec probes the timeout fails the probe but does not terminate the command running on the guest. This means a blocking command can result in an increasing load on the guest. A small buffer will be added to the resulting workload exec probe to compensate for delays caused by the qemu guest exec mechanism. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • networks object[]

    List of networks that can be attached to a vm's virtual interface.

  • Array [
  • multus object

    Represents the multus cni network.

  • default boolean

    Select the default network and add it to the multus-cni.io/default-network annotation.

  • networkName string required

    References to a NetworkAttachmentDefinition CRD object. Format: , /. If namespace is not specified, VMI namespace is assumed.

  • name string required

    Network name. Must be a DNS_LABEL and unique within the vm. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • pod object

    Represents the stock pod network interface.

  • vmIPv6NetworkCIDR string

    IPv6 CIDR for the vm network. Defaults to fd10:0:2::/120 if not specified.

  • vmNetworkCIDR string

    CIDR for vm network. Default 10.0.2.0/24 if not specified.

  • ]
  • nodeSelector object

    NodeSelector is a selector which must be true for the vmi to fit on a node. Selector which must match a node's labels for the vmi to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

  • property name* string
  • priorityClassName string

    If specified, indicates the pod's priority. If not specified, the pod priority will be default or zero if there is no default.

  • readinessProbe object

    Periodic probe of VirtualMachineInstance service readiness. VirtualmachineInstances will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • exec object

    One and only one of the following should be specified. Exec specifies the action to take, it will be executed on the guest through the qemu-guest-agent. If the guest agent is not available, this probe will fail.

  • command string[]

    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

  • failureThreshold int32

    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

  • guestAgentPing object

    GuestAgentPing contacts the qemu-guest-agent for availability checks.

  • httpGet object

    HTTPGet specifies the http request to perform.

  • host string

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

  • httpHeaders object[]

    Custom headers to set in the request. HTTP allows repeated headers.

  • Array [
  • name string required

    The header field name

  • value string required

    The header field value

  • ]
  • path string

    Path to access on the HTTP server.

  • port int-or-string required

    Default value: [object Object]

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

  • scheme string

    Possible values: [HTTP, HTTPS]

    Scheme to use for connecting to the host. Defaults to HTTP.

    Possible enum values:

    • "HTTP" means that the scheme used will be http://
    • "HTTPS" means that the scheme used will be https://
  • initialDelaySeconds int32

    Number of seconds after the VirtualMachineInstance has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • periodSeconds int32

    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

  • successThreshold int32

    Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

  • tcpSocket object

    TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

  • host string

    Optional: Host name to connect to, defaults to the pod IP.

  • port int-or-string required

    Default value: [object Object]

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

  • timeoutSeconds int32

    Number of seconds after which the probe times out. For exec probes the timeout fails the probe but does not terminate the command running on the guest. This means a blocking command can result in an increasing load on the guest. A small buffer will be added to the resulting workload exec probe to compensate for delays caused by the qemu guest exec mechanism. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • schedulerName string

    If specified, the VMI will be dispatched by specified scheduler. If not specified, the VMI will be dispatched by default scheduler.

  • startStrategy string

    StartStrategy can be set to "Paused" if Virtual Machine should be started in paused state.

  • subdomain string

    If specified, the fully qualified vmi hostname will be "...svc.". If not specified, the vmi will not have a domainname at all. The DNS entry will resolve to the vmi, no matter if the vmi itself can pick up a hostname.

  • terminationGracePeriodSeconds int64

    Grace period observed after signalling a VirtualMachineInstance to stop after which the VirtualMachineInstance is force terminated.

  • tolerations object[]

    If toleration is specified, obey all the toleration rules.

  • Array [
  • effect string

    Possible values: [NoExecute, NoSchedule, PreferNoSchedule]

    Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

    Possible enum values:

    • "NoExecute" Evict any already-running pods that do not tolerate the taint. Currently enforced by NodeController.
    • "NoSchedule" Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running. Enforced by the scheduler.
    • "PreferNoSchedule" Like TaintEffectNoSchedule, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely. Enforced by the scheduler.
  • key string

    Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.

  • operator string

    Possible values: [Equal, Exists]

    Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

    Possible enum values:

    • "Equal"
    • "Exists"
  • tolerationSeconds int64

    TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

  • value string

    Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

  • ]
  • volumes object[]

    List of volumes that can be mounted by disks belonging to the vmi.

  • Array [
  • cloudInitConfigDrive object

    CloudInitConfigDrive represents a cloud-init Config Drive user-data source. The Config Drive data will be added as a disk to the vmi. A proper cloud-init installation is required inside the guest. More info: https://cloudinit.readthedocs.io/en/latest/topics/datasources/configdrive.html

  • networkData string

    NetworkData contains config drive inline cloud-init networkdata.

  • networkDataBase64 string

    NetworkDataBase64 contains config drive cloud-init networkdata as a base64 encoded string.

  • networkDataSecretRef object

    NetworkDataSecretRef references a k8s secret that contains config drive networkdata.

  • name string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • secretRef object

    UserDataSecretRef references a k8s secret that contains config drive userdata.

  • name string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • userData string

    UserData contains config drive inline cloud-init userdata.

  • userDataBase64 string

    UserDataBase64 contains config drive cloud-init userdata as a base64 encoded string.

  • cloudInitNoCloud object

    CloudInitNoCloud represents a cloud-init NoCloud user-data source. The NoCloud data will be added as a disk to the vmi. A proper cloud-init installation is required inside the guest. More info: http://cloudinit.readthedocs.io/en/latest/topics/datasources/nocloud.html

  • networkData string

    NetworkData contains NoCloud inline cloud-init networkdata.

  • networkDataBase64 string

    NetworkDataBase64 contains NoCloud cloud-init networkdata as a base64 encoded string.

  • networkDataSecretRef object

    NetworkDataSecretRef references a k8s secret that contains NoCloud networkdata.

  • name string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • secretRef object

    UserDataSecretRef references a k8s secret that contains NoCloud userdata.

  • name string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • userData string

    UserData contains NoCloud inline cloud-init userdata.

  • userDataBase64 string

    UserDataBase64 contains NoCloud cloud-init userdata as a base64 encoded string.

  • configMap object

    ConfigMapSource represents a reference to a ConfigMap in the same namespace. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/

  • name string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • optional boolean

    Specify whether the ConfigMap or it's keys must be defined

  • volumeLabel string

    The volume label of the resulting disk inside the VMI. Different bootstrapping mechanisms require different values. Typical values are "cidata" (cloud-init), "config-2" (cloud-init) or "OEMDRV" (kickstart).

  • containerDisk object

    ContainerDisk references a docker image, embedding a qcow or raw disk. More info: https://kubevirt.gitbooks.io/user-guide/registry-disk.html

  • image string required

    Image is the name of the image with the embedded disk.

  • imagePullPolicy string

    Possible values: [Always, IfNotPresent, Never]

    Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

    Possible enum values:

    • "Always" means that kubelet always attempts to pull the latest image. Container will fail If the pull fails.
    • "IfNotPresent" means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails.
    • "Never" means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn't present
  • imagePullSecret string

    ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist.

  • path string

    Path defines the path to disk file in the container

  • dataVolume object

    DataVolume represents the dynamic creation a PVC for this volume as well as the process of populating that PVC with a disk image.

  • hotpluggable boolean

    Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

  • name string required

    Name represents the name of the DataVolume in the same namespace

  • downwardAPI object

    DownwardAPI represents downward API about the pod that should populate this volume

  • fields object[]

    Fields is a list of downward API volume file

  • Array [
  • fieldRef object

    Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

  • apiVersion string

    Version of the schema the FieldPath is written in terms of, defaults to "v1".

  • fieldPath string required

    Path of the field to select in the specified API version.

  • mode int32

    Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

  • path string required

    Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

  • resourceFieldRef object

    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

  • containerName string

    Container name: required for volumes, optional for env vars

  • divisor string

    Default value: [object Object]

    Specifies the output format of the exposed resources, defaults to "1"

  • resource string required

    Required: resource to select

  • ]
  • volumeLabel string

    The volume label of the resulting disk inside the VMI. Different bootstrapping mechanisms require different values. Typical values are "cidata" (cloud-init), "config-2" (cloud-init) or "OEMDRV" (kickstart).

  • downwardMetrics object

    DownwardMetrics adds a very small disk to VMIs which contains a limited view of host and guest metrics. The disk content is compatible with vhostmd (https://github.com/vhostmd/vhostmd) and vm-dump-metrics.

  • emptyDisk object

    EmptyDisk represents a temporary disk which shares the vmis lifecycle. More info: https://kubevirt.gitbooks.io/user-guide/disks-and-volumes.html

  • capacity string required

    Default value: [object Object]

    Capacity of the sparse disk.

  • ephemeral object

    Ephemeral is a special volume source that "wraps" specified source and provides copy-on-write image on top of it.

  • persistentVolumeClaim object

    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Directly attached to the vmi via qemu. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

  • claimName string required

    claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

  • readOnly boolean

    readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

  • hostDisk object

    HostDisk represents a disk created on the cluster level

  • capacity string

    Default value: [object Object]

    Capacity of the sparse disk

  • path string required

    The path to HostDisk image located on the cluster

  • shared boolean

    Shared indicate whether the path is shared between nodes

  • type string required

    Contains information if disk.img exists or should be created allowed options are 'Disk' and 'DiskOrCreate'

  • memoryDump object

    MemoryDump is attached to the virt launcher and is populated with a memory dump of the vmi

  • claimName string required

    claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

  • hotpluggable boolean

    Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

  • readOnly boolean

    readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

  • name string required

    Volume's name. Must be a DNS_LABEL and unique within the vmi. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • persistentVolumeClaim object

    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Directly attached to the vmi via qemu. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

  • claimName string required

    claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

  • hotpluggable boolean

    Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

  • readOnly boolean

    readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

  • secret object

    SecretVolumeSource represents a reference to a secret data in the same namespace. More info: https://kubernetes.io/docs/concepts/configuration/secret/

  • optional boolean

    Specify whether the Secret or it's keys must be defined

  • secretName string

    Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

  • volumeLabel string

    The volume label of the resulting disk inside the VMI. Different bootstrapping mechanisms require different values. Typical values are "cidata" (cloud-init), "config-2" (cloud-init) or "OEMDRV" (kickstart).

  • serviceAccount object

    ServiceAccountVolumeSource represents a reference to a service account. There can only be one volume of this type! More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

  • serviceAccountName string

    Name of the service account in the pod's namespace to use. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

  • sysprep object

    Represents a Sysprep volume source.

  • configMap object

    ConfigMap references a ConfigMap that contains Sysprep answer file named autounattend.xml that should be attached as disk of CDROM type.

  • name string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • secret object

    Secret references a k8s Secret that contains Sysprep answer file named autounattend.xml that should be attached as disk of CDROM type.

  • name string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • ]
  • status object

    Status holds the current state of the controller and brief information about its associated VirtualMachineInstance

  • conditions object[]

    Hold the state information of the VirtualMachine and its VirtualMachineInstance

  • Array [
  • lastProbeTime date-time

    Default value: [object Object]

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

  • lastTransitionTime date-time

    Default value: [object Object]

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

  • message string
  • reason string
  • status string required
  • type string required
  • ]
  • created boolean

    Created indicates if the virtual machine is created in the cluster

  • memoryDumpRequest object

    MemoryDumpRequest tracks memory dump request phase and info of getting a memory dump to the given pvc

  • claimName string required

    ClaimName is the name of the pvc that will contain the memory dump

  • endTimestamp date-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

  • fileName string

    FileName represents the name of the output file

  • message string

    Message is a detailed message about failure of the memory dump

  • phase string required

    Phase represents the memory dump phase

  • startTimestamp date-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

  • printableStatus string

    PrintableStatus is a human readable, high-level representation of the status of the virtual machine

  • ready boolean

    Ready indicates if the virtual machine is running and ready

  • restoreInProgress string

    RestoreInProgress is the name of the VirtualMachineRestore currently executing

  • snapshotInProgress string

    SnapshotInProgress is the name of the VirtualMachineSnapshot currently executing

  • startFailure object

    StartFailure tracks consecutive VMI startup failures for the purposes of crash loop backoffs

  • consecutiveFailCount int32
  • lastFailedVMIUID string
  • retryAfterTimestamp date-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

  • stateChangeRequests object[]

    StateChangeRequests indicates a list of actions that should be taken on a VMI e.g. stop a specific VMI then start a new one.

  • Array [
  • action string required

    Indicates the type of action that is requested. e.g. Start or Stop

  • data object

    Provides additional data in order to perform the Action

  • property name* string
  • uid string

    Indicates the UUID of an existing Virtual Machine Instance that this change request applies to -- if applicable

  • ]
  • volumeRequests object[]

    VolumeRequests indicates a list of volumes add or remove from the VMI template and hotplug on an active running VMI.

  • Array [
  • addVolumeOptions object

    AddVolumeOptions when set indicates a volume should be added. The details within this field specify how to add the volume

  • disk object required

    Disk represents the hotplug disk that will be plugged into the running VMI

  • blockSize object

    If specified, the virtual disk will be presented with the given block sizes.

  • custom object

    CustomBlockSize represents the desired logical and physical block size for a VM disk.

  • logical int32 required
  • physical int32 required
  • matchVolume object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • bootOrder int32

    BootOrder is an integer value > 0, used to determine ordering of boot devices. Lower values take precedence. Each disk or interface that has a boot order must have a unique value. Disks without a boot order are not tried if a disk with a boot order exists.

  • cache string

    Cache specifies which kvm disk cache mode should be used. Supported values are: CacheNone, CacheWriteThrough.

  • cdrom object

    Attach a volume as a cdrom to the vmi.

  • bus string

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

  • readonly boolean

    ReadOnly. Defaults to true.

  • tray string

    Tray indicates if the tray of the device is open or closed. Allowed values are "open" and "closed". Defaults to closed.

  • dedicatedIOThread boolean

    dedicatedIOThread indicates this disk should have an exclusive IO Thread. Enabling this implies useIOThreads = true. Defaults to false.

  • disk object

    Attach a volume as a disk to the vmi.

  • bus string

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

  • pciAddress string

    If specified, the virtual disk will be placed on the guests pci address with the specified PCI address. For example: 0000:81:01.10

  • readonly boolean

    ReadOnly. Defaults to false.

  • io string

    IO specifies which QEMU disk IO mode should be used. Supported values are: native, default, threads.

  • lun object

    Attach a volume as a LUN to the vmi.

  • bus string

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

  • readonly boolean

    ReadOnly. Defaults to false.

  • name string required

    Name is the device name

  • serial string

    Serial provides the ability to specify a serial number for the disk device.

  • shareable boolean

    If specified the disk is made sharable and multiple write from different VMs are permitted

  • tag string

    If specified, disk address and its tag will be provided to the guest via config drive metadata

  • dryRun string[]

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

  • name string required

    Name represents the name that will be used to map the disk to the corresponding volume. This overrides any name set inside the Disk struct itself.

  • volumeSource object required

    VolumeSource represents the source of the volume to map to the disk.

  • dataVolume object

    DataVolume represents the dynamic creation a PVC for this volume as well as the process of populating that PVC with a disk image.

  • hotpluggable boolean

    Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

  • name string required

    Name represents the name of the DataVolume in the same namespace

  • persistentVolumeClaim object

    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Directly attached to the vmi via qemu. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

  • claimName string required

    claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

  • hotpluggable boolean

    Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

  • readOnly boolean

    readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

  • removeVolumeOptions object

    RemoveVolumeOptions when set indicates a volume should be removed. The details within this field specify how to add the volume

  • dryRun string[]

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

  • name string required

    Name represents the name that maps to both the disk and volume that should be removed

  • ]
  • volumeSnapshotStatuses object[]

    VolumeSnapshotStatuses indicates a list of statuses whether snapshotting is supported by each volume.

  • Array [
  • enabled boolean required

    Default value: false

    True if the volume supports snapshotting

  • name string required

    Volume name

  • reason string

    Empty if snapshotting is enabled, contains reason otherwise

  • ]
Responses

OK

Schema
  • apiVersion string required

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

  • kind string required

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  • metadata object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

  • annotations object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

  • property name* string
  • clusterName string

    Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25.

    The name in the go struct is changed to help clients detect accidental use.

  • creationTimestamp date-time

    Default value: [object Object]

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

    Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

  • deletionGracePeriodSeconds int64

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

  • deletionTimestamp date-time

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

    Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

  • finalizers string[]

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

  • generateName string

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

    If this field is specified and the generated name exists, the server will return a 409.

    Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

  • generation int64

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

  • labels object

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

  • property name* string
  • managedFields object[]

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

  • Array [
  • apiVersion string

    APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

  • fieldsType string

    FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

  • fieldsV1 object

    FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

  • manager string

    Manager is an identifier of the workflow managing these fields.

  • operation string

    Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

  • subresource string

    Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

  • time date-time

    Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

  • ]
  • name string required

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

  • namespace string

    Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

    Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

  • ownerReferences object[]

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

  • Array [
  • apiVersion string required

    API version of the referent.

  • blockOwnerDeletion boolean

    If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

  • controller boolean

    If true, this reference points to the managing controller.

  • kind string required

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  • name string required

    Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

  • uid string required

    UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

  • ]
  • resourceVersion string

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

    Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

  • selfLink string

    Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

  • uid string

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

    Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

  • spec object required

    Spec contains the specification of VirtualMachineInstance created

  • dataVolumeTemplates object[]

    dataVolumeTemplates is a list of dataVolumes that the VirtualMachineInstance template can reference. DataVolumes in this list are dynamically created for the VirtualMachine and are tied to the VirtualMachine's life-cycle.

  • Array [
  • apiVersion string required

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

  • kind string required

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  • metadata object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

  • annotations object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

  • property name* string
  • clusterName string

    Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25.

    The name in the go struct is changed to help clients detect accidental use.

  • creationTimestamp date-time

    Default value: [object Object]

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

    Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

  • deletionGracePeriodSeconds int64

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

  • deletionTimestamp date-time

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

    Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

  • finalizers string[]

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

  • generateName string

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

    If this field is specified and the generated name exists, the server will return a 409.

    Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

  • generation int64

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

  • labels object

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

  • property name* string
  • managedFields object[]

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

  • Array [
  • apiVersion string

    APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

  • fieldsType string

    FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

  • fieldsV1 object

    FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

  • manager string

    Manager is an identifier of the workflow managing these fields.

  • operation string

    Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

  • subresource string

    Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

  • time date-time

    Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

  • ]
  • name string required

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

  • namespace string

    Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

    Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

  • ownerReferences object[]

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

  • Array [
  • apiVersion string required

    API version of the referent.

  • blockOwnerDeletion boolean

    If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

  • controller boolean

    If true, this reference points to the managing controller.

  • kind string required

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  • name string required

    Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

  • uid string required

    UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

  • ]
  • resourceVersion string

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

    Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

  • selfLink string

    Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

  • uid string

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

    Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

  • spec object required

    DataVolumeSpec contains the DataVolume specification.

  • checkpoints object[]

    Checkpoints is a list of DataVolumeCheckpoints, representing stages in a multistage import.

  • Array [
  • current string required

    Current is the identifier of the snapshot created for this checkpoint.

  • previous string required

    Previous is the identifier of the snapshot from the previous checkpoint.

  • ]
  • contentType string

    DataVolumeContentType options: "kubevirt", "archive"

  • finalCheckpoint boolean

    FinalCheckpoint indicates whether the current DataVolumeCheckpoint is the final checkpoint.

  • preallocation boolean

    Preallocation controls whether storage for DataVolumes should be allocated in advance.

  • priorityClassName string

    PriorityClassName for Importer, Cloner and Uploader pod

  • pvc object

    PVC is the PVC specification

  • accessModes string[]

    accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

  • dataSource object

    dataSource field can be used to specify either: An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

  • apiGroup string

    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

  • kind string required

    Kind is the type of resource being referenced

  • name string required

    Name is the name of resource being referenced

  • dataSourceRef object

    dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.

    • While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
  • apiGroup string

    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

  • kind string required

    Kind is the type of resource being referenced

  • name string required

    Name is the name of resource being referenced

  • resources object

    resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

  • limits object

    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

  • property name* string
  • requests object

    Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

  • property name* string
  • selector object

    selector is a label query over volumes to consider for binding.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • storageClassName string

    storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

  • volumeMode string

    volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

  • volumeName string

    volumeName is the binding reference to the PersistentVolume backing this claim.

  • source object

    Source is the src of the data for the requested DataVolume

  • blank object

    DataVolumeBlankImage provides the parameters to create a new raw blank image for the PVC

  • http object

    DataVolumeSourceHTTP can be either an http or https endpoint, with an optional basic auth user name and password, and an optional configmap containing additional CAs

  • certConfigMap string

    CertConfigMap is a configmap reference, containing a Certificate Authority(CA) public key, and a base64 encoded pem certificate

  • extraHeaders string[]

    ExtraHeaders is a list of strings containing extra headers to include with HTTP transfer requests

  • secretExtraHeaders string[]

    SecretExtraHeaders is a list of Secret references, each containing an extra HTTP header that may include sensitive information

  • secretRef string

    SecretRef A Secret reference, the secret should contain accessKeyId (user name) base64 encoded, and secretKey (password) also base64 encoded

  • url string required

    URL is the URL of the http(s) endpoint

  • imageio object

    DataVolumeSourceImageIO provides the parameters to create a Data Volume from an imageio source

  • certConfigMap string

    CertConfigMap provides a reference to the CA cert

  • diskId string required

    DiskID provides id of a disk to be imported

  • secretRef string

    SecretRef provides the secret reference needed to access the ovirt-engine

  • url string required

    URL is the URL of the ovirt-engine

  • pvc object

    DataVolumeSourcePVC provides the parameters to create a Data Volume from an existing PVC

  • name string required

    The name of the source PVC

  • namespace string required

    The namespace of the source PVC

  • registry object

    DataVolumeSourceRegistry provides the parameters to create a Data Volume from an registry source

  • certConfigMap string

    CertConfigMap provides a reference to the Registry certs

  • imageStream string

    ImageStream is the name of image stream for import

  • pullMethod string

    PullMethod can be either "pod" (default import), or "node" (node docker cache based import)

  • secretRef string

    SecretRef provides the secret reference needed to access the Registry source

  • url string

    URL is the url of the registry source (starting with the scheme: docker, oci-archive)

  • s3 object

    DataVolumeSourceS3 provides the parameters to create a Data Volume from an S3 source

  • certConfigMap string

    CertConfigMap is a configmap reference, containing a Certificate Authority(CA) public key, and a base64 encoded pem certificate

  • secretRef string

    SecretRef provides the secret reference needed to access the S3 source

  • url string required

    URL is the url of the S3 source

  • upload object

    DataVolumeSourceUpload provides the parameters to create a Data Volume by uploading the source

  • vddk object

    DataVolumeSourceVDDK provides the parameters to create a Data Volume from a Vmware source

  • backingFile string

    BackingFile is the path to the virtual hard disk to migrate from vCenter/ESXi

  • initImageURL string

    InitImageURL is an optional URL to an image containing an extracted VDDK library, overrides v2v-vmware config map

  • secretRef string

    SecretRef provides a reference to a secret containing the username and password needed to access the vCenter or ESXi host

  • thumbprint string

    Thumbprint is the certificate thumbprint of the vCenter or ESXi host

  • url string

    URL is the URL of the vCenter or ESXi host with the VM to migrate

  • uuid string

    UUID is the UUID of the virtual machine that the backing file is attached to in vCenter/ESXi

  • sourceRef object

    SourceRef is an indirect reference to the source of data for the requested DataVolume

  • kind string required

    The kind of the source reference, currently only "DataSource" is supported

  • name string required

    The name of the source reference

  • namespace string

    The namespace of the source reference, defaults to the DataVolume namespace

  • storage object

    Storage is the requested storage specification

  • accessModes string[]

    AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

  • dataSource object

    This field can be used to specify either: An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source.

  • apiGroup string

    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

  • kind string required

    Kind is the type of resource being referenced

  • name string required

    Name is the name of resource being referenced

  • resources object

    Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

  • limits object

    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

  • property name* string
  • requests object

    Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

  • property name* string
  • selector object

    A label query over volumes to consider for binding.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • storageClassName string

    Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

  • volumeMode string

    volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

  • volumeName string

    VolumeName is the binding reference to the PersistentVolume backing this claim.

  • status object

    DataVolumeTemplateDummyStatus is here simply for backwards compatibility with a previous API.

  • ]
  • flavor object

    FlavorMatcher references a flavor that is used to fill fields in Template

  • kind string

    Kind specifies which flavor resource is referenced. Allowed values are: "VirtualMachineFlavor" and "VirtualMachineClusterFlavor". If not specified, "VirtualMachineClusterFlavor" is used by default.

  • name string required

    Name is the name of the VirtualMachineFlavor or VirtualMachineClusterFlavor

  • preference object

    PreferenceMatcher references a set of preference that is used to fill fields in Template

  • kind string

    Kind specifies which preference resource is referenced. Allowed values are: "VirtualMachinePreference" and "VirtualMachineClusterPreference". If not specified, "VirtualMachineClusterPreference" is used by default.

  • name string required

    Name is the name of the VirtualMachinePreference or VirtualMachineClusterPreference

  • runStrategy string

    Running state indicates the requested running state of the VirtualMachineInstance mutually exclusive with Running

  • running boolean

    Running controls whether the associatied VirtualMachineInstance is created or not Mutually exclusive with RunStrategy

  • template object required

    Template is the direct specification of VirtualMachineInstance

  • metadata object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

  • annotations object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

  • property name* string
  • clusterName string

    Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25.

    The name in the go struct is changed to help clients detect accidental use.

  • creationTimestamp date-time

    Default value: [object Object]

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

    Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

  • deletionGracePeriodSeconds int64

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

  • deletionTimestamp date-time

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

    Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

  • finalizers string[]

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

  • generateName string

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

    If this field is specified and the generated name exists, the server will return a 409.

    Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

  • generation int64

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

  • labels object

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

  • property name* string
  • managedFields object[]

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

  • Array [
  • apiVersion string

    APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

  • fieldsType string

    FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

  • fieldsV1 object

    FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

  • manager string

    Manager is an identifier of the workflow managing these fields.

  • operation string

    Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

  • subresource string

    Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

  • time date-time

    Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

  • ]
  • name string required

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

  • namespace string

    Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

    Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

  • ownerReferences object[]

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

  • Array [
  • apiVersion string required

    API version of the referent.

  • blockOwnerDeletion boolean

    If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

  • controller boolean

    If true, this reference points to the managing controller.

  • kind string required

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  • name string required

    Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

  • uid string required

    UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

  • ]
  • resourceVersion string

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

    Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

  • selfLink string

    Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

  • uid string

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

    Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

  • spec object

    VirtualMachineInstance Spec contains the VirtualMachineInstance specification.

  • accessCredentials object[]

    Specifies a set of public keys to inject into the vm guest

  • Array [
  • sshPublicKey object

    SSHPublicKey represents the source and method of applying a ssh public key into a guest virtual machine.

  • propagationMethod object required

    PropagationMethod represents how the public key is injected into the vm guest.

  • configDrive object

    ConfigDrivePropagation means that the ssh public keys are injected into the VM using metadata using the configDrive cloud-init provider

  • qemuGuestAgent object

    QemuGuestAgentAccessCredentailPropagation means ssh public keys are dynamically injected into the vm at runtime via the qemu guest agent. This feature requires the qemu guest agent to be running within the guest.

  • users string[] required

    Users represents a list of guest users that should have the ssh public keys added to their authorized_keys file.

  • source object required

    Source represents where the public keys are pulled from

  • secret object

    Secret means that the access credential is pulled from a kubernetes secret

  • secretName string required

    SecretName represents the name of the secret in the VMI's namespace

  • userPassword object

    UserPassword represents the source and method for applying a guest user's password

  • propagationMethod object required

    propagationMethod represents how the user passwords are injected into the vm guest.

  • qemuGuestAgent object

    QemuGuestAgentAccessCredentailPropagation means passwords are dynamically injected into the vm at runtime via the qemu guest agent. This feature requires the qemu guest agent to be running within the guest.

  • source object required

    Source represents where the user passwords are pulled from

  • secret object

    Secret means that the access credential is pulled from a kubernetes secret

  • secretName string required

    SecretName represents the name of the secret in the VMI's namespace

  • ]
  • affinity object

    If affinity is specifies, obey all the affinity rules

  • nodeAffinity object

    Describes node affinity scheduling rules for the pod.

  • preferredDuringSchedulingIgnoredDuringExecution object[]

    The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.

  • Array [
  • preference object required

    A node selector term, associated with the corresponding weight.

  • matchExpressions object[]

    A list of node selector requirements by node's labels.

  • Array [
  • key string required

    The label key that the selector applies to.

  • operator string required

    Possible values: [DoesNotExist, Exists, Gt, In, Lt, NotIn]

    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

    Possible enum values:

    • "DoesNotExist"
    • "Exists"
    • "Gt"
    • "In"
    • "Lt"
    • "NotIn"
  • values string[]

    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

  • ]
  • matchFields object[]

    A list of node selector requirements by node's fields.

  • Array [
  • key string required

    The label key that the selector applies to.

  • operator string required

    Possible values: [DoesNotExist, Exists, Gt, In, Lt, NotIn]

    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

    Possible enum values:

    • "DoesNotExist"
    • "Exists"
    • "Gt"
    • "In"
    • "Lt"
    • "NotIn"
  • values string[]

    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

  • ]
  • weight int32 required

    Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

  • ]
  • requiredDuringSchedulingIgnoredDuringExecution object

    If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

  • nodeSelectorTerms object[] required

    Required. A list of node selector terms. The terms are ORed.

  • Array [
  • matchExpressions object[]

    A list of node selector requirements by node's labels.

  • Array [
  • key string required

    The label key that the selector applies to.

  • operator string required

    Possible values: [DoesNotExist, Exists, Gt, In, Lt, NotIn]

    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

    Possible enum values:

    • "DoesNotExist"
    • "Exists"
    • "Gt"
    • "In"
    • "Lt"
    • "NotIn"
  • values string[]

    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

  • ]
  • matchFields object[]

    A list of node selector requirements by node's fields.

  • Array [
  • key string required

    The label key that the selector applies to.

  • operator string required

    Possible values: [DoesNotExist, Exists, Gt, In, Lt, NotIn]

    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

    Possible enum values:

    • "DoesNotExist"
    • "Exists"
    • "Gt"
    • "In"
    • "Lt"
    • "NotIn"
  • values string[]

    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

  • ]
  • ]
  • podAffinity object

    Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

  • preferredDuringSchedulingIgnoredDuringExecution object[]

    The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

  • Array [
  • podAffinityTerm object required

    Required. A pod affinity term, associated with the corresponding weight.

  • labelSelector object

    A label query over a set of resources, in this case pods.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • namespaceSelector object

    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • namespaces string[]

    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

  • topologyKey string required

    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

  • weight int32 required

    weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

  • ]
  • requiredDuringSchedulingIgnoredDuringExecution object[]

    If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

  • Array [
  • labelSelector object

    A label query over a set of resources, in this case pods.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • namespaceSelector object

    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • namespaces string[]

    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

  • topologyKey string required

    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

  • ]
  • podAntiAffinity object

    Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

  • preferredDuringSchedulingIgnoredDuringExecution object[]

    The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

  • Array [
  • podAffinityTerm object required

    Required. A pod affinity term, associated with the corresponding weight.

  • labelSelector object

    A label query over a set of resources, in this case pods.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • namespaceSelector object

    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • namespaces string[]

    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

  • topologyKey string required

    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

  • weight int32 required

    weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

  • ]
  • requiredDuringSchedulingIgnoredDuringExecution object[]

    If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

  • Array [
  • labelSelector object

    A label query over a set of resources, in this case pods.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • namespaceSelector object

    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

  • matchExpressions object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [
  • key string required

    key is the label key that the selector applies to.

  • operator string required

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values string[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]
  • matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
  • namespaces string[]

    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

  • topologyKey string required

    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

  • ]
  • dnsConfig object

    Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

  • nameservers string[]

    A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.

  • options object[]

    A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.

  • Array [
  • name string

    Required.

  • value string
  • ]
  • searches string[]

    A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.

  • dnsPolicy string

    Possible values: [ClusterFirst, ClusterFirstWithHostNet, Default, None]

    Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

    Possible enum values:

    • "ClusterFirst" indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
    • "ClusterFirstWithHostNet" indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
    • "Default" indicates that the pod should use the default (as determined by kubelet) DNS settings.
    • "None" indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
  • domain object required

    Specification of the desired behavior of the VirtualMachineInstance on the host.

  • chassis object

    Chassis specifies the chassis info passed to the domain.

  • asset string
  • manufacturer string
  • serial string
  • sku string
  • version string
  • clock object

    Clock sets the clock and timers of the vmi.

  • timer object

    Timer specifies whih timers are attached to the vmi.

  • hpet object

    HPET (High Precision Event Timer) - multiple timers with periodic interrupts.

  • present boolean

    Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

  • tickPolicy string

    TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup", "merge", "discard".

  • hyperv object

    Hyperv (Hypervclock) - lets guests read the host’s wall clock time (paravirtualized). For windows guests.

  • present boolean

    Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

  • kvm object

    KVM (KVM clock) - lets guests read the host’s wall clock time (paravirtualized). For linux guests.

  • present boolean

    Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

  • pit object

    PIT (Programmable Interval Timer) - a timer with periodic interrupts.

  • present boolean

    Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

  • tickPolicy string

    TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup", "discard".

  • rtc object

    RTC (Real Time Clock) - a continuously running timer with periodic interrupts.

  • present boolean

    Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

  • tickPolicy string

    TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup".

  • track string

    Track the guest or the wall clock.

  • timezone string

    Timezone sets the guest clock to the specified timezone. Zone name follows the TZ environment variable format (e.g. 'America/New_York').

  • utc object

    UTC sets the guest clock to UTC on each boot. If an offset is specified, guest changes to the clock will be kept during reboots and are not reset.

  • offsetSeconds int32

    OffsetSeconds specifies an offset in seconds, relative to UTC. If set, guest changes to the clock will be kept during reboots and not reset.

  • cpu object

    CPU allow specified the detailed CPU topology inside the vmi.

  • cores int64

    Cores specifies the number of cores inside the vmi. Must be a value greater or equal 1.

  • dedicatedCpuPlacement boolean

    DedicatedCPUPlacement requests the scheduler to place the VirtualMachineInstance on a node with enough dedicated pCPUs and pin the vCPUs to it.

  • features object[]

    Features specifies the CPU features list inside the VMI.

  • Array [
  • name string required

    Name of the CPU feature

  • policy string

    Policy is the CPU feature attribute which can have the following attributes: force - The virtual CPU will claim the feature is supported regardless of it being supported by host CPU. require - Guest creation will fail unless the feature is supported by the host CPU or the hypervisor is able to emulate it. optional - The feature will be supported by virtual CPU if and only if it is supported by host CPU. disable - The feature will not be supported by virtual CPU. forbid - Guest creation will fail if the feature is supported by host CPU. Defaults to require

  • ]
  • isolateEmulatorThread boolean

    IsolateEmulatorThread requests one more dedicated pCPU to be allocated for the VMI to place the emulator thread on it.

  • model string

    Model specifies the CPU model inside the VMI. List of available models https://github.com/libvirt/libvirt/tree/master/src/cpu_map. It is possible to specify special cases like "host-passthrough" to get the same CPU as the node and "host-model" to get CPU closest to the node one. Defaults to host-model.

  • numa object

    NUMA allows specifying settings for the guest NUMA topology

  • guestMappingPassthrough object

    GuestMappingPassthrough will create an efficient guest topology based on host CPUs exclusively assigned to a pod. The created topology ensures that memory and CPUs on the virtual numa nodes never cross boundaries of host numa nodes.

  • realtime object

    Realtime instructs the virt-launcher to tune the VMI for lower latency, optional for real time workloads

  • mask string

    Mask defines the vcpu mask expression that defines which vcpus are used for realtime. Format matches libvirt's expressions. Example: "0-3,^1","0,2,3","2-3"

  • sockets int64

    Sockets specifies the number of sockets inside the vmi. Must be a value greater or equal 1.

  • threads int64

    Threads specifies the number of threads inside the vmi. Must be a value greater or equal 1.

  • devices object required

    Devices allows adding disks, network interfaces, and others

  • autoattachGraphicsDevice boolean

    Whether to attach the default graphics device or not. VNC will not be available if set to false. Defaults to true.

  • autoattachMemBalloon boolean

    Whether to attach the Memory balloon device with default period. Period can be adjusted in virt-config. Defaults to true.

  • autoattachPodInterface boolean

    Whether to attach a pod network interface. Defaults to true.

  • autoattachSerialConsole boolean

    Whether to attach the default serial console or not. Serial console access will not be available if set to false. Defaults to true.

  • blockMultiQueue boolean

    Whether or not to enable virtio multi-queue for block devices. Defaults to false.

  • clientPassthrough object

    To configure and access client devices such as redirecting USB

  • disableHotplug boolean

    DisableHotplug disabled the ability to hotplug disks.

  • disks object[]

    Disks describes disks, cdroms and luns which are connected to the vmi.

  • Array [
  • blockSize object

    If specified, the virtual disk will be presented with the given block sizes.

  • custom object

    CustomBlockSize represents the desired logical and physical block size for a VM disk.

  • logical int32 required
  • physical int32 required
  • matchVolume object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • bootOrder int32

    BootOrder is an integer value > 0, used to determine ordering of boot devices. Lower values take precedence. Each disk or interface that has a boot order must have a unique value. Disks without a boot order are not tried if a disk with a boot order exists.

  • cache string

    Cache specifies which kvm disk cache mode should be used. Supported values are: CacheNone, CacheWriteThrough.

  • cdrom object

    Attach a volume as a cdrom to the vmi.

  • bus string

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

  • readonly boolean

    ReadOnly. Defaults to true.

  • tray string

    Tray indicates if the tray of the device is open or closed. Allowed values are "open" and "closed". Defaults to closed.

  • dedicatedIOThread boolean

    dedicatedIOThread indicates this disk should have an exclusive IO Thread. Enabling this implies useIOThreads = true. Defaults to false.

  • disk object

    Attach a volume as a disk to the vmi.

  • bus string

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

  • pciAddress string

    If specified, the virtual disk will be placed on the guests pci address with the specified PCI address. For example: 0000:81:01.10

  • readonly boolean

    ReadOnly. Defaults to false.

  • io string

    IO specifies which QEMU disk IO mode should be used. Supported values are: native, default, threads.

  • lun object

    Attach a volume as a LUN to the vmi.

  • bus string

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

  • readonly boolean

    ReadOnly. Defaults to false.

  • name string required

    Name is the device name

  • serial string

    Serial provides the ability to specify a serial number for the disk device.

  • shareable boolean

    If specified the disk is made sharable and multiple write from different VMs are permitted

  • tag string

    If specified, disk address and its tag will be provided to the guest via config drive metadata

  • ]
  • filesystems object[]

    Filesystems describes filesystem which is connected to the vmi.

  • Array [
  • name string required

    Name is the device name

  • virtiofs object required

    Virtiofs is supported

  • ]
  • gpus object[]

    Whether to attach a GPU device to the vmi.

  • Array [
  • deviceName string required
  • name string required

    Name of the GPU device as exposed by a device plugin

  • tag string

    If specified, the virtual network interface address and its tag will be provided to the guest via config drive

  • virtualGPUOptions object
  • display object
  • enabled boolean

    Enabled determines if a display addapter backed by a vGPU should be enabled or disabled on the guest. Defaults to true.

  • ramFB object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • ]
  • hostDevices object[]

    Whether to attach a host device to the vmi.

  • Array [
  • deviceName string required

    DeviceName is the resource name of the host device exposed by a device plugin

  • name string required
  • tag string

    If specified, the virtual network interface address and its tag will be provided to the guest via config drive

  • ]
  • inputs object[]

    Inputs describe input devices

  • Array [
  • bus string

    Bus indicates the bus of input device to emulate. Supported values: virtio, usb.

  • name string required

    Name is the device name

  • type string required

    Type indicated the type of input device. Supported values: tablet.

  • ]
  • interfaces object[]

    Interfaces describe network interfaces which are added to the vmi.

  • Array [
  • bootOrder int32

    BootOrder is an integer value > 0, used to determine ordering of boot devices. Lower values take precedence. Each interface or disk that has a boot order must have a unique value. Interfaces without a boot order are not tried.

  • bridge object

    InterfaceBridge connects to a given network via a linux bridge.

  • dhcpOptions object

    If specified the network interface will pass additional DHCP options to the VMI

  • bootFileName string

    If specified will pass option 67 to interface's DHCP server

  • ntpServers string[]

    If specified will pass the configured NTP server to the VM via DHCP option 042.

  • privateOptions object[]

    If specified will pass extra DHCP options for private use, range: 224-254

  • Array [
  • option int32 required

    Option is an Integer value from 224-254 Required.

  • value string required

    Value is a String value for the Option provided Required.

  • ]
  • tftpServerName string

    If specified will pass option 66 to interface's DHCP server

  • macAddress string

    Interface MAC address. For example: de:ad:00:00:be:af or DE-AD-00-00-BE-AF.

  • macvtap object

    InterfaceMacvtap connects to a given network by extending the Kubernetes node's L2 networks via a macvtap interface.

  • masquerade object

    InterfaceMasquerade connects to a given network using netfilter rules to nat the traffic.

  • model string

    Interface model. One of: e1000, e1000e, ne2k_pci, pcnet, rtl8139, virtio. Defaults to virtio.

  • name string required

    Logical name of the interface as well as a reference to the associated networks. Must match the Name of a Network.

  • pciAddress string

    If specified, the virtual network interface will be placed on the guests pci address with the specified PCI address. For example: 0000:81:01.10

  • ports object[]

    List of ports to be forwarded to the virtual machine.

  • Array [
  • name string

    If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

  • port int32 required

    Number of port to expose for the virtual machine. This must be a valid port number, 0 < x < 65536.

  • protocol string

    Protocol for port. Must be UDP or TCP. Defaults to "TCP".

  • ]
  • slirp object

    InterfaceSlirp connects to a given network using QEMU user networking mode.

  • sriov object

    InterfaceSRIOV connects to a given network by passing-through an SR-IOV PCI device via vfio.

  • tag string

    If specified, the virtual network interface address and its tag will be provided to the guest via config drive

  • ]
  • networkInterfaceMultiqueue boolean

    If specified, virtual network interfaces configured with a virtio bus will also enable the vhost multiqueue feature for network devices. The number of queues created depends on additional factors of the VirtualMachineInstance, like the number of guest CPUs.

  • rng object

    Whether to have random number generator from host

  • sound object

    Whether to emulate a sound device.

  • model string

    We only support ich9 or ac97. If SoundDevice is not set: No sound card is emulated. If SoundDevice is set but Model is not: ich9

  • name string required

    User's defined name for this sound device

  • tpm object

    Whether to emulate a TPM device.

  • useVirtioTransitional boolean

    Fall back to legacy virtio 0.9 support if virtio bus is selected on devices. This is helpful for old machines like CentOS6 or RHEL6 which do not understand virtio_non_transitional (virtio 1.0).

  • watchdog object

    Watchdog describes a watchdog device which can be added to the vmi.

  • i6300esb object

    i6300esb watchdog device.

  • action string

    The action to take. Valid values are poweroff, reset, shutdown. Defaults to reset.

  • name string required

    Name of the watchdog.

  • features object

    Features like acpi, apic, hyperv, smm.

  • acpi object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • apic object

    Defaults to the machine type setting.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • endOfInterrupt boolean

    EndOfInterrupt enables the end of interrupt notification in the guest. Defaults to false.

  • hyperv object

    Defaults to the machine type setting.

  • evmcs object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • frequencies object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • ipi object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • reenlightenment object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • relaxed object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • reset object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • runtime object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • spinlocks object

    Spinlocks allows to configure the spinlock retry attempts.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • spinlocks int64

    Retries indicates the number of retries. Must be a value greater or equal 4096. Defaults to 4096.

  • synic object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • synictimer object

    SyNICTimer enables Synthetic Interrupt Controller Timers, reducing CPU load. Defaults to the machine type setting.

  • direct object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • enabled boolean
  • tlbflush object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • vapic object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • vendorid object

    VendorID allows setting the hypervisor vendor id. Defaults to the machine type setting.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • vendorid string

    VendorID sets the hypervisor vendor id, visible to the vmi. String up to twelve characters.

  • vpindex object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • kvm object

    Configure how KVM presence is exposed to the guest.

  • hidden boolean

    Hide the KVM hypervisor from standard MSR based discovery. Defaults to false

  • pvspinlock object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • smm object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • firmware object

    Firmware.

  • bootloader object

    Settings to control the bootloader that is used.

  • bios object

    If set (default), BIOS will be used.

  • useSerial boolean

    If set, the BIOS output will be transmitted over serial

  • efi object

    If set, EFI will be used instead of BIOS.

  • secureBoot boolean

    If set, SecureBoot will be enabled and the OVMF roms will be swapped for SecureBoot-enabled ones. Requires SMM to be enabled. Defaults to true

  • kernelBoot object

    Settings to set the kernel for booting.

  • container object

    Container defines the container that containes kernel artifacts

  • image string required

    Image that contains initrd / kernel files.

  • imagePullPolicy string

    Possible values: [Always, IfNotPresent, Never]

    Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

    Possible enum values:

    • "Always" means that kubelet always attempts to pull the latest image. Container will fail If the pull fails.
    • "IfNotPresent" means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails.
    • "Never" means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn't present
  • imagePullSecret string

    ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist.

  • initrdPath string

    the fully-qualified path to the ramdisk image in the host OS

  • kernelPath string

    The fully-qualified path to the kernel image in the host OS

  • kernelArgs string

    Arguments to be passed to the kernel at boot time

  • serial string

    The system-serial-number in SMBIOS

  • uuid string

    UUID reported by the vmi bios. Defaults to a random generated uid.

  • ioThreadsPolicy string

    Controls whether or not disks will share IOThreads. Omitting IOThreadsPolicy disables use of IOThreads. One of: shared, auto

  • launchSecurity object

    Launch Security setting of the vmi.

  • sev object

    AMD Secure Encrypted Virtualization (SEV).

  • machine object

    Machine type.

  • type string

    QEMU machine type is the actual chipset of the VirtualMachineInstance.

  • memory object

    Memory allow specifying the VMI memory features.

  • guest string

    Guest allows to specifying the amount of memory which is visible inside the Guest OS. The Guest must lie between Requests and Limits from the resources section. Defaults to the requested memory in the resources section if not specified.

  • hugepages object

    Hugepages allow to use hugepages for the VirtualMachineInstance instead of regular memory.

  • pageSize string

    PageSize specifies the hugepage size, for x86_64 architecture valid values are 1Gi and 2Mi.

  • resources object

    Resources describes the Compute Resources required by this vmi.

  • limits object

    Limits describes the maximum amount of compute resources allowed. Valid resource keys are "memory" and "cpu".

  • property name* string
  • overcommitGuestOverhead boolean

    Don't ask the scheduler to take the guest-management overhead into account. Instead put the overhead only into the container's memory limit. This can lead to crashes if all memory is in use on a node. Defaults to false.

  • requests object

    Requests is a description of the initial vmi resources. Valid resource keys are "memory" and "cpu".

  • property name* string
  • evictionStrategy string

    EvictionStrategy can be set to "LiveMigrate" if the VirtualMachineInstance should be migrated instead of shut-off in case of a node drain.

  • hostname string

    Specifies the hostname of the vmi If not specified, the hostname will be set to the name of the vmi, if dhcp or cloud-init is configured properly.

  • livenessProbe object

    Periodic probe of VirtualMachineInstance liveness. VirtualmachineInstances will be stopped if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • exec object

    One and only one of the following should be specified. Exec specifies the action to take, it will be executed on the guest through the qemu-guest-agent. If the guest agent is not available, this probe will fail.

  • command string[]

    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

  • failureThreshold int32

    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

  • guestAgentPing object

    GuestAgentPing contacts the qemu-guest-agent for availability checks.

  • httpGet object

    HTTPGet specifies the http request to perform.

  • host string

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

  • httpHeaders object[]

    Custom headers to set in the request. HTTP allows repeated headers.

  • Array [
  • name string required

    The header field name

  • value string required

    The header field value

  • ]
  • path string

    Path to access on the HTTP server.

  • port int-or-string required

    Default value: [object Object]

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

  • scheme string

    Possible values: [HTTP, HTTPS]

    Scheme to use for connecting to the host. Defaults to HTTP.

    Possible enum values:

    • "HTTP" means that the scheme used will be http://
    • "HTTPS" means that the scheme used will be https://
  • initialDelaySeconds int32

    Number of seconds after the VirtualMachineInstance has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • periodSeconds int32

    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

  • successThreshold int32

    Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

  • tcpSocket object

    TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

  • host string

    Optional: Host name to connect to, defaults to the pod IP.

  • port int-or-string required

    Default value: [object Object]

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

  • timeoutSeconds int32

    Number of seconds after which the probe times out. For exec probes the timeout fails the probe but does not terminate the command running on the guest. This means a blocking command can result in an increasing load on the guest. A small buffer will be added to the resulting workload exec probe to compensate for delays caused by the qemu guest exec mechanism. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • networks object[]

    List of networks that can be attached to a vm's virtual interface.

  • Array [
  • multus object

    Represents the multus cni network.

  • default boolean

    Select the default network and add it to the multus-cni.io/default-network annotation.

  • networkName string required

    References to a NetworkAttachmentDefinition CRD object. Format: , /. If namespace is not specified, VMI namespace is assumed.

  • name string required

    Network name. Must be a DNS_LABEL and unique within the vm. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • pod object

    Represents the stock pod network interface.

  • vmIPv6NetworkCIDR string

    IPv6 CIDR for the vm network. Defaults to fd10:0:2::/120 if not specified.

  • vmNetworkCIDR string

    CIDR for vm network. Default 10.0.2.0/24 if not specified.

  • ]
  • nodeSelector object

    NodeSelector is a selector which must be true for the vmi to fit on a node. Selector which must match a node's labels for the vmi to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

  • property name* string
  • priorityClassName string

    If specified, indicates the pod's priority. If not specified, the pod priority will be default or zero if there is no default.

  • readinessProbe object

    Periodic probe of VirtualMachineInstance service readiness. VirtualmachineInstances will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • exec object

    One and only one of the following should be specified. Exec specifies the action to take, it will be executed on the guest through the qemu-guest-agent. If the guest agent is not available, this probe will fail.

  • command string[]

    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

  • failureThreshold int32

    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

  • guestAgentPing object

    GuestAgentPing contacts the qemu-guest-agent for availability checks.

  • httpGet object

    HTTPGet specifies the http request to perform.

  • host string

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

  • httpHeaders object[]

    Custom headers to set in the request. HTTP allows repeated headers.

  • Array [
  • name string required

    The header field name

  • value string required

    The header field value

  • ]
  • path string

    Path to access on the HTTP server.

  • port int-or-string required

    Default value: [object Object]

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

  • scheme string

    Possible values: [HTTP, HTTPS]

    Scheme to use for connecting to the host. Defaults to HTTP.

    Possible enum values:

    • "HTTP" means that the scheme used will be http://
    • "HTTPS" means that the scheme used will be https://
  • initialDelaySeconds int32

    Number of seconds after the VirtualMachineInstance has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • periodSeconds int32

    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

  • successThreshold int32

    Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

  • tcpSocket object

    TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

  • host string

    Optional: Host name to connect to, defaults to the pod IP.

  • port int-or-string required

    Default value: [object Object]

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

  • timeoutSeconds int32

    Number of seconds after which the probe times out. For exec probes the timeout fails the probe but does not terminate the command running on the guest. This means a blocking command can result in an increasing load on the guest. A small buffer will be added to the resulting workload exec probe to compensate for delays caused by the qemu guest exec mechanism. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • schedulerName string

    If specified, the VMI will be dispatched by specified scheduler. If not specified, the VMI will be dispatched by default scheduler.

  • startStrategy string

    StartStrategy can be set to "Paused" if Virtual Machine should be started in paused state.

  • subdomain string

    If specified, the fully qualified vmi hostname will be "...svc.". If not specified, the vmi will not have a domainname at all. The DNS entry will resolve to the vmi, no matter if the vmi itself can pick up a hostname.

  • terminationGracePeriodSeconds int64

    Grace period observed after signalling a VirtualMachineInstance to stop after which the VirtualMachineInstance is force terminated.

  • tolerations object[]

    If toleration is specified, obey all the toleration rules.

  • Array [
  • effect string

    Possible values: [NoExecute, NoSchedule, PreferNoSchedule]

    Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

    Possible enum values:

    • "NoExecute" Evict any already-running pods that do not tolerate the taint. Currently enforced by NodeController.
    • "NoSchedule" Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running. Enforced by the scheduler.
    • "PreferNoSchedule" Like TaintEffectNoSchedule, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely. Enforced by the scheduler.
  • key string

    Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.

  • operator string

    Possible values: [Equal, Exists]

    Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

    Possible enum values:

    • "Equal"
    • "Exists"
  • tolerationSeconds int64

    TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

  • value string

    Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

  • ]
  • volumes object[]

    List of volumes that can be mounted by disks belonging to the vmi.

  • Array [
  • cloudInitConfigDrive object

    CloudInitConfigDrive represents a cloud-init Config Drive user-data source. The Config Drive data will be added as a disk to the vmi. A proper cloud-init installation is required inside the guest. More info: https://cloudinit.readthedocs.io/en/latest/topics/datasources/configdrive.html

  • networkData string

    NetworkData contains config drive inline cloud-init networkdata.

  • networkDataBase64 string

    NetworkDataBase64 contains config drive cloud-init networkdata as a base64 encoded string.

  • networkDataSecretRef object

    NetworkDataSecretRef references a k8s secret that contains config drive networkdata.

  • name string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • secretRef object

    UserDataSecretRef references a k8s secret that contains config drive userdata.

  • name string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • userData string

    UserData contains config drive inline cloud-init userdata.

  • userDataBase64 string

    UserDataBase64 contains config drive cloud-init userdata as a base64 encoded string.

  • cloudInitNoCloud object

    CloudInitNoCloud represents a cloud-init NoCloud user-data source. The NoCloud data will be added as a disk to the vmi. A proper cloud-init installation is required inside the guest. More info: http://cloudinit.readthedocs.io/en/latest/topics/datasources/nocloud.html

  • networkData string

    NetworkData contains NoCloud inline cloud-init networkdata.

  • networkDataBase64 string

    NetworkDataBase64 contains NoCloud cloud-init networkdata as a base64 encoded string.

  • networkDataSecretRef object

    NetworkDataSecretRef references a k8s secret that contains NoCloud networkdata.

  • name string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • secretRef object

    UserDataSecretRef references a k8s secret that contains NoCloud userdata.

  • name string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • userData string

    UserData contains NoCloud inline cloud-init userdata.

  • userDataBase64 string

    UserDataBase64 contains NoCloud cloud-init userdata as a base64 encoded string.

  • configMap object

    ConfigMapSource represents a reference to a ConfigMap in the same namespace. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/

  • name string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • optional boolean

    Specify whether the ConfigMap or it's keys must be defined

  • volumeLabel string

    The volume label of the resulting disk inside the VMI. Different bootstrapping mechanisms require different values. Typical values are "cidata" (cloud-init), "config-2" (cloud-init) or "OEMDRV" (kickstart).

  • containerDisk object

    ContainerDisk references a docker image, embedding a qcow or raw disk. More info: https://kubevirt.gitbooks.io/user-guide/registry-disk.html

  • image string required

    Image is the name of the image with the embedded disk.

  • imagePullPolicy string

    Possible values: [Always, IfNotPresent, Never]

    Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

    Possible enum values:

    • "Always" means that kubelet always attempts to pull the latest image. Container will fail If the pull fails.
    • "IfNotPresent" means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails.
    • "Never" means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn't present
  • imagePullSecret string

    ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist.

  • path string

    Path defines the path to disk file in the container

  • dataVolume object

    DataVolume represents the dynamic creation a PVC for this volume as well as the process of populating that PVC with a disk image.

  • hotpluggable boolean

    Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

  • name string required

    Name represents the name of the DataVolume in the same namespace

  • downwardAPI object

    DownwardAPI represents downward API about the pod that should populate this volume

  • fields object[]

    Fields is a list of downward API volume file

  • Array [
  • fieldRef object

    Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

  • apiVersion string

    Version of the schema the FieldPath is written in terms of, defaults to "v1".

  • fieldPath string required

    Path of the field to select in the specified API version.

  • mode int32

    Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

  • path string required

    Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

  • resourceFieldRef object

    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

  • containerName string

    Container name: required for volumes, optional for env vars

  • divisor string

    Default value: [object Object]

    Specifies the output format of the exposed resources, defaults to "1"

  • resource string required

    Required: resource to select

  • ]
  • volumeLabel string

    The volume label of the resulting disk inside the VMI. Different bootstrapping mechanisms require different values. Typical values are "cidata" (cloud-init), "config-2" (cloud-init) or "OEMDRV" (kickstart).

  • downwardMetrics object

    DownwardMetrics adds a very small disk to VMIs which contains a limited view of host and guest metrics. The disk content is compatible with vhostmd (https://github.com/vhostmd/vhostmd) and vm-dump-metrics.

  • emptyDisk object

    EmptyDisk represents a temporary disk which shares the vmis lifecycle. More info: https://kubevirt.gitbooks.io/user-guide/disks-and-volumes.html

  • capacity string required

    Default value: [object Object]

    Capacity of the sparse disk.

  • ephemeral object

    Ephemeral is a special volume source that "wraps" specified source and provides copy-on-write image on top of it.

  • persistentVolumeClaim object

    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Directly attached to the vmi via qemu. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

  • claimName string required

    claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

  • readOnly boolean

    readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

  • hostDisk object

    HostDisk represents a disk created on the cluster level

  • capacity string

    Default value: [object Object]

    Capacity of the sparse disk

  • path string required

    The path to HostDisk image located on the cluster

  • shared boolean

    Shared indicate whether the path is shared between nodes

  • type string required

    Contains information if disk.img exists or should be created allowed options are 'Disk' and 'DiskOrCreate'

  • memoryDump object

    MemoryDump is attached to the virt launcher and is populated with a memory dump of the vmi

  • claimName string required

    claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

  • hotpluggable boolean

    Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

  • readOnly boolean

    readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

  • name string required

    Volume's name. Must be a DNS_LABEL and unique within the vmi. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • persistentVolumeClaim object

    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Directly attached to the vmi via qemu. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

  • claimName string required

    claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

  • hotpluggable boolean

    Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

  • readOnly boolean

    readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

  • secret object

    SecretVolumeSource represents a reference to a secret data in the same namespace. More info: https://kubernetes.io/docs/concepts/configuration/secret/

  • optional boolean

    Specify whether the Secret or it's keys must be defined

  • secretName string

    Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

  • volumeLabel string

    The volume label of the resulting disk inside the VMI. Different bootstrapping mechanisms require different values. Typical values are "cidata" (cloud-init), "config-2" (cloud-init) or "OEMDRV" (kickstart).

  • serviceAccount object

    ServiceAccountVolumeSource represents a reference to a service account. There can only be one volume of this type! More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

  • serviceAccountName string

    Name of the service account in the pod's namespace to use. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

  • sysprep object

    Represents a Sysprep volume source.

  • configMap object

    ConfigMap references a ConfigMap that contains Sysprep answer file named autounattend.xml that should be attached as disk of CDROM type.

  • name string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • secret object

    Secret references a k8s Secret that contains Sysprep answer file named autounattend.xml that should be attached as disk of CDROM type.

  • name string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • ]
  • status object

    Status holds the current state of the controller and brief information about its associated VirtualMachineInstance

  • conditions object[]

    Hold the state information of the VirtualMachine and its VirtualMachineInstance

  • Array [
  • lastProbeTime date-time

    Default value: [object Object]

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

  • lastTransitionTime date-time

    Default value: [object Object]

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

  • message string
  • reason string
  • status string required
  • type string required
  • ]
  • created boolean

    Created indicates if the virtual machine is created in the cluster

  • memoryDumpRequest object

    MemoryDumpRequest tracks memory dump request phase and info of getting a memory dump to the given pvc

  • claimName string required

    ClaimName is the name of the pvc that will contain the memory dump

  • endTimestamp date-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

  • fileName string

    FileName represents the name of the output file

  • message string

    Message is a detailed message about failure of the memory dump

  • phase string required

    Phase represents the memory dump phase

  • startTimestamp date-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

  • printableStatus string

    PrintableStatus is a human readable, high-level representation of the status of the virtual machine

  • ready boolean

    Ready indicates if the virtual machine is running and ready

  • restoreInProgress string

    RestoreInProgress is the name of the VirtualMachineRestore currently executing

  • snapshotInProgress string

    SnapshotInProgress is the name of the VirtualMachineSnapshot currently executing

  • startFailure object

    StartFailure tracks consecutive VMI startup failures for the purposes of crash loop backoffs

  • consecutiveFailCount int32
  • lastFailedVMIUID string
  • retryAfterTimestamp date-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

  • stateChangeRequests object[]

    StateChangeRequests indicates a list of actions that should be taken on a VMI e.g. stop a specific VMI then start a new one.

  • Array [
  • action string required

    Indicates the type of action that is requested. e.g. Start or Stop

  • data object

    Provides additional data in order to perform the Action

  • property name* string
  • uid string

    Indicates the UUID of an existing Virtual Machine Instance that this change request applies to -- if applicable

  • ]
  • volumeRequests object[]

    VolumeRequests indicates a list of volumes add or remove from the VMI template and hotplug on an active running VMI.

  • Array [
  • addVolumeOptions object

    AddVolumeOptions when set indicates a volume should be added. The details within this field specify how to add the volume

  • disk object required

    Disk represents the hotplug disk that will be plugged into the running VMI

  • blockSize object

    If specified, the virtual disk will be presented with the given block sizes.

  • custom object

    CustomBlockSize represents the desired logical and physical block size for a VM disk.

  • logical int32 required
  • physical int32 required
  • matchVolume object

    Represents if a feature is enabled or disabled.

  • enabled boolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • bootOrder int32

    BootOrder is an integer value > 0, used to determine ordering of boot devices. Lower values take precedence. Each disk or interface that has a boot order must have a unique value. Disks without a boot order are not tried if a disk with a boot order exists.

  • cache string

    Cache specifies which kvm disk cache mode should be used. Supported values are: CacheNone, CacheWriteThrough.

  • cdrom object

    Attach a volume as a cdrom to the vmi.

  • bus string

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

  • readonly boolean

    ReadOnly. Defaults to true.

  • tray string

    Tray indicates if the tray of the device is open or closed. Allowed values are "open" and "closed". Defaults to closed.

  • dedicatedIOThread boolean

    dedicatedIOThread indicates this disk should have an exclusive IO Thread. Enabling this implies useIOThreads = true. Defaults to false.

  • disk object

    Attach a volume as a disk to the vmi.

  • bus string

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

  • pciAddress string

    If specified, the virtual disk will be placed on the guests pci address with the specified PCI address. For example: 0000:81:01.10

  • readonly boolean

    ReadOnly. Defaults to false.

  • io string

    IO specifies which QEMU disk IO mode should be used. Supported values are: native, default, threads.

  • lun object

    Attach a volume as a LUN to the vmi.

  • bus string

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

  • readonly boolean

    ReadOnly. Defaults to false.

  • name string required

    Name is the device name

  • serial string

    Serial provides the ability to specify a serial number for the disk device.

  • shareable boolean

    If specified the disk is made sharable and multiple write from different VMs are permitted

  • tag string

    If specified, disk address and its tag will be provided to the guest via config drive metadata

  • dryRun string[]

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

  • name string required

    Name represents the name that will be used to map the disk to the corresponding volume. This overrides any name set inside the Disk struct itself.

  • volumeSource object required

    VolumeSource represents the source of the volume to map to the disk.

  • dataVolume object

    DataVolume represents the dynamic creation a PVC for this volume as well as the process of populating that PVC with a disk image.

  • hotpluggable boolean

    Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

  • name string required

    Name represents the name of the DataVolume in the same namespace

  • persistentVolumeClaim object

    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Directly attached to the vmi via qemu. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

  • claimName string required

    claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

  • hotpluggable boolean

    Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

  • readOnly boolean

    readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

  • removeVolumeOptions object

    RemoveVolumeOptions when set indicates a volume should be removed. The details within this field specify how to add the volume

  • dryRun string[]

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

  • name string required

    Name represents the name that maps to both the disk and volume that should be removed

  • ]
  • volumeSnapshotStatuses object[]

    VolumeSnapshotStatuses indicates a list of statuses whether snapshotting is supported by each volume.

  • Array [
  • enabled boolean required

    Default value: false

    True if the volume supports snapshotting

  • name string required

    Volume name

  • reason string

    Empty if snapshotting is enabled, contains reason otherwise

  • ]
Loading...
最后于 更新